Skip to content

fix: prevent state table collision by including system/user prefix#37195

Open
shashidhar-bm wants to merge 1 commit intoapache:masterfrom
shashidhar-bm:fix-state-table-prefix-collision
Open

fix: prevent state table collision by including system/user prefix#37195
shashidhar-bm wants to merge 1 commit intoapache:masterfrom
shashidhar-bm:fix-state-table-prefix-collision

Conversation

@shashidhar-bm
Copy link

@shashidhar-bm shashidhar-bm commented Dec 28, 2025

This PR fixes a bug where StateTable and CachingStateTable were only using the raw ID for equality checks, ignoring the system/user prefix. This could lead to data corruption if a user-defined state tag happened to share the same ID as a system-defined one.

Changes:

  • Added getIdWithPrefix() to the StateTag interface to expose the full identifier.
  • Updated StateTags.ID_EQUIVALENCE and SimpleStateTag to incorporate the prefix in equality and hash calculations.
  • Modified CachingStateTable to use the prefixed ID in its internal StateTableKey.
  • Added unit tests to verify that tags with the same ID but different prefixes no longer collide.

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

Fixes #36753

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@gemini-code-assist
Copy link
Contributor

gemini-code-assist bot commented Dec 28, 2025

Summary of Changes

Hello @ShashidharM0118, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a critical bug in state management where StateTable and CachingStateTable could experience collisions between system-defined and user-defined state tags if they happened to share the same raw identifier. By introducing a mechanism to include a system/user prefix in state tag identifiers, the changes ensure that each state tag has a globally unique key, thereby preventing data corruption and enhancing the robustness of state handling within the system.

Highlights

  • Introduced Prefixed State Tag IDs: Added a new default method, getIdWithPrefix(), to the StateTag interface. This method provides a unique identifier that includes a system/user prefix, crucial for distinguishing state tags.
  • Updated State Tag Equivalence Logic: Modified StateTags.ID_EQUIVALENCE and the SimpleStateTag inner class to utilize the new prefixed ID for accurate equality checks and hash code calculations, ensuring proper identification.
  • Prevented State Table Collisions: Updated CachingStateTable to use the prefixed ID when creating StateTableKey instances. This resolves a bug where system and user-defined state tags with identical raw IDs could collide, leading to data corruption.
  • Enhanced Test Coverage: Added new unit tests to StateTagTest.java to validate the functionality of getIdWithPrefix() and confirm that state tags with the same raw ID but different prefixes are correctly distinguished, preventing unintended collisions.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

@github-actions
Copy link
Contributor

github-actions bot commented Dec 28, 2025

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

@shashidhar-bm shashidhar-bm force-pushed the fix-state-table-prefix-collision branch from b33ac54 to 4a73a9b Compare December 28, 2025 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

core dataflow runners

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Bug]: Add system/user prefix to getId in StateTable, CachingStateTable

1 participant

@shashidhar-bm